home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / boot / czesc_2 / magicword1.1 / magicword.doc < prev    next >
Text File  |  1994-06-25  |  11KB  |  205 lines
  1. Documentation for MagicWord 1.1
  2. -------------------------------
  3.  
  4. (c) 1992/93/94
  5.  
  6. Author: Urs Fleisch
  7.         Leimatstr. 38
  8.         CH-9000 St. Gallen
  9. E-mail: ufleisch@stud.ee.ethz.ch
  10.  
  11. This program is PUBLIC DOMAIN, and may be freely distributed, however
  12. always together with this documentation!
  13.  
  14. V1.1:  With OS 2.0:  MagicWord runs as a Commodity, supports ToolTypes and
  15. Workbench-Arguments, Application-Window and writes icons.
  16.  
  17. MagicWord is a universal utility for word replacement and macros.  Other
  18. than special solutions in editors and wordprocessors, MagicWord works with
  19. nearly every wordprocessor, editor and any other utility.  Instead of
  20. recording macros for every application, it is easier to record the macros
  21. once with MagicWord for you'll be able to use them with future applications
  22. too.  The use of MagicWord is only limited by the ideas of the user.
  23. This versatility can be used especially by replacing words.  So you can let
  24. MagicWord type your address simply by typing \adr in any application.
  25. MagicWord can also be used as a little data base because you get access to
  26. information by typing keywords.  The access is done rather quick by
  27. hashing.
  28.  
  29. You can start MagicWord from Shell or Workbench.  From Shell you can
  30. provide MagicWord with the name of a macro file, which will be loaded
  31. automatically (Kickstart 1.3).  From Workbench, MagicWord can also be
  32. started together with icons of MagicWord-files or by starting a
  33. MagicWord-file (OS 2.0).  MagicWord doesn't need any library to run, but it
  34. is able to use the ARP and ASL-Requesters.  So arp.library is recommended
  35. for Kickstart 1.3, asl.library for Kickstart 2.0 and 3.0.
  36. From OS 2.0, MagicWord runs as a Commodity, i.e.  you can configure the
  37. program with ToolTypes, MagicWord can run silent in background and opens
  38. its window when the HotKey has been typed.  MagicWord provides the usual
  39. Commodity-ToolTypes:  Run as a commodity, the MagicWord-window only appears
  40. if there's a ToolType CX_POPUP=YES set.  Otherwise nothing happens on the
  41. screen after starting the program.  The program is now waiting for the
  42. HotKey to be pressed.  The default HotKey is "lalt control m".  Pressing
  43. this key combination activates MagicWord and the window will appear.
  44. Closing the window doesn't kill MagicWord in memory, it still waits for the
  45. HotKey until you kill it by choosing the menu "Project/Quit", by starting
  46. it again or by killing it from Commodities-Exchange.
  47. The HotKey and the Commodity's priority can be set by the ToolTypes
  48. CX_POPKEY and CX_PRIORITY.  The default selection is "CX_POPKEY=lalt
  49. control m" and "CX_PRIORITY=0".  You can assign any
  50. Commodities-HotKey-string to CX_POPKEY, e.g.  shift, alt, caps, control,
  51. lshift, rshift, lalt, ralt, lcommand, rcommand and so forth.  The active
  52. HotKey is diplayed in the titlebar of the MagicWord window.  CX_PRIORITY
  53. can reach from -128 to 127.  By setting CX_POPUP=YES, the window pops up
  54. after starting MagicWord.  The default value is CX_POPUP=NO.  Another
  55. ToolType is "FILE=filename", where filename is the name of a macro file,
  56. which will be loaded at every start of MagicWord.
  57. When started with invalid ToolTypes, MagicWord makes use of the default
  58. settings.  You can also deliver the ToolTypes to PutChar when starting from
  59. CLI or a script like s:user-startup, e.g.  'Run >NIL:  MagicWord
  60. CX_POPKEY="control f10" CX_PRIORITY=1 FILE=defs.mw'.  Here, CX_POPUP works
  61. as a switch, so don't write CX_POPUP=YES, but only CX_POPUP to let the
  62. window appear when the program is started.
  63.  
  64. MagicWord opens a window with half height of the actual default public
  65. screen.  A cursor indicates that you can edit in this window.  The program
  66. offers the following menu items:
  67.  
  68. Project/Open: Load a macro file
  69. Project/Save As: Store the macros in memory
  70. Project/Hide: Hide window, when run as a commodity.
  71. Project/Quit: Quit program
  72. Macros/New: Record a new macro
  73. Macros/Delete: Delete an existing macro
  74. Macros/Delete All: Delete all macros in memory
  75. Macros/Show: Show all macros in memory
  76.  
  77. Here comes a more detailed description of the menu functions:
  78.  
  79. Macros/New:  This function may be used first.  It enables you to record
  80. keypresses for a new macro.  First it requests the name of the macro.  This
  81. name can contain letters, numbers and symbols, but no spaces or backslash
  82. "\" for this character marks the begin of a macro name.  The program won't
  83. distinguish between upper and lower case.  The macro name can be deleted by
  84. typing Backspace or Del, input is finished by typing Return or Enter.  From
  85. now on, MagicWord records your keypresses until you select the menu
  86. Record/finished.  Now the macro is stored in memory and may be used by
  87. typing a backslash "\" followed by the defined macro name.
  88. Example:  Select Macros/New, the message "Input new word!" will appear.
  89. Now we type "adr" followed by Return.  Now the program tells you that it is
  90. recording all keypresses.  You can type your text in any application, e.g.
  91. in the wordprocessor to use this text with.  So we change to our
  92. application an type our address:  "Hermann User<RETURN>Bitstreet
  93. 256<RETURN>1024 Bytetown<RETURN>.  Now we return to MagicWord and select
  94. the menu Record/finished, MagicWord confirms that it has stopped recording
  95. keypresses.  You can also type the text to record in the MagicWord-window
  96. which offers you a simple editor.
  97. A macro can contain 2000 keypresses.  Be aware that the typing of the
  98. Backspace or Delete-Key won't edit the macro data.  The keypress will be
  99. recorded and later reproduced like every other key.
  100. Now we type "\adr" in any application or in MagicWord, and \adr is being
  101. deleted and replaced by the recorded text.  Be sure that you typed in the
  102. macro name correctly, or you've got to retype the whole text (with
  103. preceding backslash "\"!).  Finish by typing Space or Return.  It is
  104. important that you start the macro name with a backslash, so MagicWord
  105. recognizes the macro without checking every word and slowing down your
  106. machine.
  107. Macros are stored in memory dynamically.  MagicWord compares every word
  108. which starts with a backslash with the macros in memory by calculating the
  109. position by hashing (just like the AmigaDOS file system).  So access should
  110. be pretty quick.  The number of macros isn't limited, so you could fill all
  111. RAM with macros.
  112.  
  113. Macros/Delete:  Deletes a macro from memory.  You've got to type in the
  114. macro name.  Notice that memory won't be freed until you select
  115. "Macros/Delete all" or quit the program.
  116.  
  117. Macros/Delete All:  This function deletes all macros in memory and frees
  118. the used memory.
  119.  
  120. Macros/Show:  Prints out all macro names in order of their appearance in
  121. the hash table.  The associated text can be displayed by typing the macro
  122. name with preceding backslash.
  123.  
  124. Project/Save As:  By choosing this function you can save all macros in
  125. memory to disk.  While saving, MagicWord prints out the name of the macro
  126. currently saved.  If available, the filename can be chosen using the ARP-
  127. or ASL-Filerequester.  Otherwise, you'll have to put up with a simple
  128. requester.
  129. With OS 2.0, MagicWord writes its files with icons.
  130.  
  131. Project/Open:  Allows you to load a MagicWord file.  Again, you may find an
  132. ARP- or ASL-Requester and the names of the loaded macros are being
  133. displayed.  The macros from the chosen file are loaded to the ones already
  134. in memory.  Existing macros with the same name will be overwritten.  This
  135. function is also invoked when MagicWord has been started with a filename as
  136. an argument (Kickstart 1.3) or with the FILE-ToolType (OS 2.0).
  137. From OS 2.0, the MagicWord window is an application window.  You can load a
  138. file by dropping its icon over the MagicWord window.
  139.  
  140. Project/Hide:  (from OS 2.0) By choosing this menu or closing the window,
  141. the MagicWord window disappears and it will appear when the HotKey is
  142. typed.  Then MagicWord runs in the background.
  143.  
  144. Project/Quit:  You can leave the program by selecting this menu item.  No
  145. more macros will be available to other applications.
  146.  
  147. That's all.  Now I want to add some hints.
  148.  
  149. When you use MagicWord to replace words, nearly every application (DTP,
  150. wordprocessors, editors...) can take advantage from its word replacement
  151. faculty.  From the many tested programs, only "Beckertext I" and "SuperED
  152. C" don't work with MagicWord.  The problem may be their key processing over
  153. Intuition, which remembers only four keypresses.  This limits also the
  154. recording of short cut keys to select menu functions from macros.  If an
  155. application uses it's own menu keyboard handling (e.g.  WordPerfect),
  156. there's no problem.
  157. Because you can move and click the mouse by keypresses, MagicWord can also
  158. guide the mouse.  But you must look out for some things:
  159.  
  160. * The mouse pointer can be moved by holding an Amiga key and pressing the
  161. cursor keys.  By holding down a cursor key, the pointer moves quickly,
  162. single keypresses move it with little steps.  If you hold down a shift key,
  163. the pointer takes larger steps.
  164. MagicWord generates only single keypresses.  You should only (even to
  165. simulate the right mouse button) use the left Amiga key (lAmiga), for the
  166. right one generates repeated keypresses.  To move the pointer faster, you
  167. may hold down shift.
  168. Before moving the mouse pointer, it should be positioned.  E.g.  you can
  169. move it with the mouse to the lower right corner; while recording, you can
  170. move it to the upper left corner by pressing lAmiga-Shift-Left and
  171. lAmiga-Shift-Up.  So you can be sure that the pointer will get to the upper
  172. left corner from every position.  Now you can move the pointer to the
  173. desired position.
  174. => Move pointer:  Place pointer and move it with lAmiga-Shift-Cursor keys
  175.    or lAmiga-Cursor keys with single keypresses.
  176.  
  177. * To simulate the left mouse button, it's not sufficient to press
  178. lAmiga-lAlt for both of them are qualifier keys.  In addition, you've got
  179. to press a normal key without function, e.g.  F1.  To simulate a double
  180. clicking, you should press a normal key alone between the mouse clicks.
  181. => left mouse button: press lAlt-lAmiga-F1.
  182.    double click:      press lAlt-lAmiga-F1, F1, lAlt-lAmiga-F1.
  183.  
  184. * To select a menu, you may want to simulate the right mouse button.  Move
  185. the pointer and hold down the right Alt key.  When you're over the menu
  186. item, release all keys.  Again:  record single keypresses, use shift for
  187. fast movement.
  188. => Select menu:  move pointer with lAmiga-rAlt-Cursor keys to the menu
  189.    item, then release the keys.
  190.  
  191. That's for the mouse simulation.  Now other hints:
  192.  
  193. * In the Shell, a macro may replace a batch file.  Simply record some often
  194. used commands.
  195.  
  196. * You don't need an editor to invoke a macro.  You may also type blindly on
  197. the Workbench screen.
  198.  
  199. * You can get often used addresses or your own letterhead simply by typing
  200. one name.
  201.  
  202. * You can record phrases like Hello, Yours sincerly, Greetings...
  203.  
  204. * Programmers may record frames for their programmes, titles, comments...
  205.